/* 
 * Copyright (c) 2004-2006 Massachusetts Institute of Technology. This code was
 * developed as part of the Haystack (http://haystack.lcs.mit.edu/) research 
 * project at MIT. Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation files (the 
 * "Software"), to deal in the Software without restriction, including without 
 * limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom
 * the Software is furnished to do so, subject to the following conditions: 
 * 
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software. 
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE. 
 */

/*
 * Created on Oct 2, 2006
 */
package edu.mit.csail.relo.jdt.builder;

import org.openrdf.model.Resource;

import edu.mit.csail.relo.modelBridge.Artifact;
import edu.mit.csail.relo.store.ReloRdfRepository;

/**
 * RDFBuildProcessors process the RDF made available from the extractors and
 * generate more RDF. They exist for one of two reasons:
 * 
 * o To allow for an easier/more-intuitive model from either the developers
 * perspective or the users perspective
 * 
 * o To do caching, so that we can extract this data faster
 * 
 * It will be nice/interesting to define what protocol the 'process' methods
 * take. For now they are only classes & interfaces, but generalizing before a
 * concrete use-case is a bad idea - we are therefore leaving the name, but not
 * supporting the functionality.
 * 
 * @author vineet
 * TODO: integrate the progress monitor here
 */
public abstract class ReloRDFBuildProcessor {
    protected Artifact projArt;
    protected ReloRdfRepository rdfRepo;

    public void init(ReloRdfRepository rdfRepo, Artifact projArt) {
        this.rdfRepo = rdfRepo;
        this.projArt = projArt;
    }

    public void process(Resource classRes) {
        // 'per resource' processing
    }
    
    public void finishProcessing() {
        // entire project processing
    }
    
    public void cleanAnnotations() {
        // cleaning up annotations
    }
}
